Motion.PowerAxis method

Enables or disables the operation of an axis.

Namespace: IntervalZero.KINGSTAR.Local.Api

Assembly: IntervalZero.KINGSTAR.Local.Api (in IntervalZero.KINGSTAR.Local.dll) Version: 4.4.0.0

Syntax

C#VB

public KsCommandStatus PowerAxis(
       int Index,
       bool Enable,
       bool EnablePositiveDirection,
       bool EnableNegativeDirection
)

Public Function PowerAxis(
       Index As Integer,
       Enable As Boolean,
       EnablePositiveDirection As Boolean,
       EnableNegativeDirection As Boolean
) As KsCommandStatus

Parameters

Index [in]

Type: int

The index of an axis. Indexes are zero based. Aliases affect this parameter.

Enable [in]

Type: bool

true to enable the axis, false to disable the axis.

EnablePositiveDirection [in]

Type: bool

true to let the axis move into the positive direction.

EnableNegativeDirection [in]

Type: bool

true to let the axis move into the negative direction.

Return value

Type: KsCommandStatus

Returns the KsCommandStatus class.

Remarks

It starts or stops the servo motor and prevents overtravel of an axis.

Examples

N/A